<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  <html xmlns="http://www.w3.org/1999/xhtml">
		<head>
			<!-- template designed by Marco Von Ballmoos -->
			<title>Docs For Class Plupload</title>
			<link rel="stylesheet" href="../media/stylesheet.css" />
			<meta http-equiv='Content-Type' content='text/html; charset=utf-8'/>
		</head>
		<body>
			<div class="page-body">			
<h2 class="class-name">Class Plupload</h2>

<a name="sec-description"></a>
<div class="info-box">
	<div class="info-box-title">Description</div>
	<div class="nav-bar">
					<span class="disabled">Description</span> |
													<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Plupload library.</p>
	<ul class="tags">
				<li><span class="field">author:</span> Andrej Jursa</li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_libraries---plupload.php.html">/libraries/plupload.php</a> (line <span class="field"><a href="../__filesource/fsource_LIST_Libraries__librariesplupload.php.html#a8">8</a></span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>



	<a name="sec-var-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Variable Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
						<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
							| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
								</div>
		<div class="info-box-body">
			<div class="var-summary">
																								<div class="var-title">
					<span class="var-type">object codeIgniter</span>
					<a href="#$CI" title="details" class="var-name">$CI</a>
				</div>
											</div>
		</div>
	</div>

	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
																		<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
				 
				|
						<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
		</div>
		<div class="info-box-body">			
			<div class="method-summary">
																																												
												<div class="method-definition">
											<span class="method-result">Plupload</span>
										<a href="#__construct" title="details" class="method-name">__construct</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">boolean</span>
										<a href="#clear_temporary_files" title="details" class="method-name">clear_temporary_files</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$targetDir</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#do_upload" title="details" class="method-name">do_upload</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$targetDir</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#get_new_filename" title="details" class="method-name">get_new_filename</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$fileName</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$targetDir</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">boolean</span>
										<a href="#remove_temporary_files" title="details" class="method-name">remove_temporary_files</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$targetDir</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$filePath</span> = <span class="var-default">''</span>])
									</div>
								</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<a name="var$CI" id="$CI"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">object codeIgniter</span>
			<span class="var-name">$CI</span>
						(line <span class="line-number"><a href="../__filesource/fsource_LIST_Libraries__librariesplupload.php.html#a13">13</a></span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">var:</span> object.</li>
				<li><span class="field">access:</span> private</li>
			</ul>
	
	
		
		

</div>
						
		</div>
	</div>
	
	<a name="sec-methods"></a>
	<div class="info-box">
		<div class="info-box-title">Methods</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
																	<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
						
		</div>
		<div class="info-box-body">
			<A NAME='method_detail'></A>

<a name="method__construct" id="__construct"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">Constructor __construct</span> (line <span class="line-number"><a href="../__filesource/fsource_LIST_Libraries__librariesplupload.php.html#a18">18</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Main constructor, will loads codeigniter instance and langfile for plupload.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">Plupload</span>
		<span class="method-name">
			__construct
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodclear_temporary_files" id="clear_temporary_files"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">clear_temporary_files</span> (line <span class="line-number"><a href="../__filesource/fsource_LIST_Libraries__librariesplupload.php.html#a113">113</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Clear target directory for all old temporary files.</p>
	<ul class="tags">
				<li><span class="field">return:</span> information about successfullnes of operation.</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">boolean</span>
		<span class="method-name">
			clear_temporary_files
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$targetDir</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$targetDir</span><span class="var-description">: target directory to be clear.</span>			</li>
				</ul>
		
			
	</div>
<a name="methoddo_upload" id="do_upload"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">do_upload</span> (line <span class="line-number"><a href="../__filesource/fsource_LIST_Libraries__librariesplupload.php.html#a28">28</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Realises upload procedure by plupload.</p>
<p class="description"><p>WARNING: calling this method will brake code execution and return JSON response in all cases.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			do_upload
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$targetDir</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$targetDir</span><span class="var-description">: target directory.</span>			</li>
				</ul>
		
			
	</div>
<a name="methodget_new_filename" id="get_new_filename"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">get_new_filename</span> (line <span class="line-number"><a href="../__filesource/fsource_LIST_Libraries__librariesplupload.php.html#a123">123</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return new filename if provided one is already taken by another file in terget directory.</p>
	<ul class="tags">
				<li><span class="field">return:</span> new name.</li>
				<li><span class="field">access:</span> private</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			get_new_filename
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$fileName</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$targetDir</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$fileName</span><span class="var-description">: current file name.</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$targetDir</span><span class="var-description">: target directory.</span>			</li>
				</ul>
		
			
	</div>
<a name="methodremove_temporary_files" id="remove_temporary_files"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">remove_temporary_files</span> (line <span class="line-number"><a href="../__filesource/fsource_LIST_Libraries__librariesplupload.php.html#a141">141</a></span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Remove all temporary files from target directory, except the one specified in $filePath.</p>
	<ul class="tags">
				<li><span class="field">return:</span> TRUE, when directory is scaned and files are removed, FALSE when target directory is not directory or can't be opened.</li>
				<li><span class="field">access:</span> private</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">boolean</span>
		<span class="method-name">
			remove_temporary_files
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$targetDir</span>, [<span class="var-type">string</span>&nbsp;<span class="var-name">$filePath</span> = <span class="var-default">''</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$targetDir</span><span class="var-description">: target directory.</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$filePath</span><span class="var-description">: path to file which is not to be deleted (i.e. it is currently uploaded file).</span>			</li>
				</ul>
		
			
	</div>
						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Fri, 13 Sep 2013 12:32:42 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.4</a>
	</p>
	</div></body>
</html>